home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format CD 48 / Amiga Format CD48 (1999-12-13)(Future Publishing)(GB)(Track 1 of 2)[!][issue 2000-01].iso / -serious- / misc / stringsnip / stringsnip.readme < prev    next >
Text File  |  1999-11-01  |  11KB  |  313 lines
  1. Short:    Much better editing features in string gadgets
  2. Uploader: thor@einstein.math.tu-berlin.de
  3. Author:   thor@einstein.math.tu-berlin.de (Thomas Richter)
  4. Type:     util/sys
  5. Version:  2.04
  6. Requires: Os 2.04, optionally ViNCEd.
  7. _____________________________________________________________________________
  8.  
  9. New in release 2.04:
  10.  
  11.     - Due to some unfortune, an internal structure appeared on an odd
  12.       address which caused a crash on 68000 and 68010 based systems.
  13.       Nothing else changed.
  14.  
  15. New in release 2.03:
  16.  
  17.     - Fixed a possible incompatibility of Amiga-V that could have
  18.       resulted in inserting a string twice if the application edit
  19.       hook is able to parse this key as well.
  20.  
  21. New in release 2.02:
  22.  
  23.     - The NumLock function was erraneously bound to Alt-Ü on german
  24.       keyboards. Never thrust a Data-Becker book, especially when
  25.       looking up key-codes.
  26.  
  27. New in release 2.01.1:
  28.  
  29.     - Included a sample preferences file for those people that don't
  30.       read ReadMes. (-;
  31.  
  32. New in release 2.01:
  33.  
  34.     - Almost a complete rewrite, fully configurable with ViNCEd style
  35.       preferences (vnc.library required).
  36.     - Includes now TAB expansions and much more editor commands.
  37. _____________________________________________________________________________
  38.  
  39.  
  40. The following table shows the default configuration for string gadget hooks:
  41.  
  42. Alt+Cursor keys:    Move to beginning of next/previous word
  43. Alt+Ctrl+Cursor keys:    Move to beginning of next/previous path component
  44. Shift+Cursor keys:    Move to start/end of the contents.
  45. Alt+Cursor keys:    ditto.
  46. Alt+Del:        Clear the contents.
  47. Shift+Del:        ditto.
  48. ALT+Backspace:        Erase to the beginning of the word under the cursor
  49. Shift+Alt+Del:        Erase text behind the cursor
  50. Shift+Alt+BS:        Erase text before the cursor position
  51. Amiga+X:        Cut the contents of the gadget to the clipboard
  52. Amiga+C:        Copy the contents to the clipboard
  53. Amiga+V:        Insert the clipboard contents into the gadget
  54. Shift+Amiga+V:        Replace the string gadget contents by the clipboard
  55. Aniga+Q:        Undo-operation
  56. Ctrl+Tab:        TAB expansion
  57. Ctrl+Shift+Tab:        TAB expansion backwards
  58. Commodore-key:        Turn off the extended editing features temporary
  59.  
  60.  
  61. The configuration is, however, fully adjustable with the SetVNC program
  62. of the "ViNCEd" package, see below for details.
  63.  
  64. The TAB expansion is a "cut down" version of the ViNCEd style expansion
  65. mechanism without a double-TAB requester, without the complete command
  66. path search and without a TAB expansion cache.
  67. Please note that string gadget does not come with a "natural" directory the 
  68. TAB expansion should search in, hence the path to be expanded must be either
  69. absolute or relative to the boot volume, i.e. SYS:
  70.  
  71. (This file is actually a part of the ViNCEd distribution. See 
  72. util/shell/ViNCEd.lha for the complete archive).
  73.  
  74.  
  75. Installation:
  76.     Copy to your C: drawer.
  77.  
  78.     StringSnip install    To install the extended editing features
  79.     StringSnip remove    To remove it again.
  80.  
  81. Additionally:    
  82.     Copy the demo prefs file below to ENVARC:StringSnip.prefs and 
  83.     add the line
  84.  
  85.     StringSnip PREFS ENV:StringSnip.prefs INSTALL
  86. _____________________________________________________________________________
  87.  
  88. Extended options, full synopsis:
  89.  
  90. StringSnip INSTALL/S,REMOVE/S,PREFS/K,HELP/S
  91.  
  92.  
  93. INSTALL/S            Installs the enhanced string edit hook
  94.                 or replaces a previously installed 
  95.                 "StringSnip" copy.
  96.                 This is the default operation.
  97.  
  98. REMOVE/S            Remove the StringSnip hook.
  99.  
  100. PREFS/K                Specifies a file name where the preferences
  101.                 should be taken from. This is a text based
  102.                 ViNCEd-compatible preferences file. It
  103.                 should be created by the "SetVNC" program
  104.                 and should be placed somehwere in the ENV:
  105.                 drawer.
  106.                 THIS OPTION REQUIRES the vnc.library, i.e.
  107.                 ViNCEd must have been installed.
  108.  
  109. HELP/S                Prints a tiny overview about the command line
  110.                 options.
  111. _____________________________________________________________________________
  112.  
  113. The preferences file: 
  114.  
  115. It is recommended that you use the "SetVNC" program of the ViNCEd package
  116. to generate this file, as the vnc.library is required anyways to read it.
  117.  
  118. As last resort, an ASCII editor is enough to edit this file, though.
  119.  
  120. The file is a listing of options, followed by an "=" ("equals") sign,
  121. followed by the value you want to set the option to. This must be "on"
  122. or "off" for boolean options, a number for numerical or a key specification
  123. for the keyboard configuration options. Commands must be introduced by a
  124. semicolon.
  125.  
  126. Here's a list of the options that are meaningfull to StringSnip. The lines
  127. below could be cut out and written directly to a file, for example to
  128. ENVARC:StringSnip.prefs.
  129.  
  130. ___________cut here__________________________________________________________
  131.  
  132. WRAP=off        
  133. ;whether the TAB expansion wraps around or not.
  134.  
  135. ;TAB expansion settings:
  136. ;These are priorities how the list of found nodes are sorted and in
  137. ;which order they appear. The list of found matches can be cycled thru
  138. ;with the TAB expansion keys, as in ViNCEd.
  139.  
  140. TAB_FILE_PRI=0        
  141. ;priority of non-executable non-script files
  142. TAB_EXEC_PRI=2        
  143. ;priority of executables.
  144. TAB_SCRIPT_PRI=1    
  145. ;priority of script files.
  146. TAB_INFO_PRI=-10    
  147. ;priority of icons
  148. TAB_DEVICE_PRI=-2    
  149. ;of devices
  150. TAB_ASSIGN_PRI=-2    
  151. ;of assigns (logical devices)
  152. TAB_VOLUME_PRI=-2    
  153. ;of volume names
  154. TAB_DIRECTORY_PRI=3    
  155. ;of directories
  156. TAB_FULLEXPAND=off    
  157. ;should the first TAB expand the file completely?
  158.  
  159.  
  160. ;Keyboard:
  161. ;These are one or more qualifiers, i.e.
  162. ; Alt, Shift for either shift or alt key, RAmiga, LAmiga, RShift, LShift,
  163. ; RAlt, RAlt for the right/left modifier keys, "Num" if numlock is "on".
  164. ; The numlock is a special modifier that is toggled by an additional key
  165. ; to be set up here, it is completely unrelated to the "numeric keypad"
  166. ;and a key name, as "Left" "Right" for the cursor keys or
  167. ;a keyboard code, or an ASCII value enclosed in single quotes if the
  168. ;key should be matched on an ASCII string and not on a physical key.
  169. ;Details about this again in the ViNCEd guide.
  170. ;
  171. CURSOR_LEFT=Left
  172. CURSOR_RIGHT=Right        
  173. ;guess what...
  174. HALF_SCREEN_LEFT=Shift Left    
  175. ;moves one string gadget width
  176. HALF_SCREEN_RIGHT=Shift Right    
  177. ;to the left/right (not used by default)
  178. TO_LEFT_BORDER=Ctrl Left
  179. TO_RIGHT_BORDER=Ctrl Right    
  180. ;moves to the boundary
  181. PREV_WORD=Alt Left
  182. NEXT_WORD=Alt Right        
  183. ;moves word-wise
  184. PREV_COMPONENT=Ctrl Alt Left
  185. NEXT_COMPONENT=Ctrl Alt Right    
  186. ;moves path-component-wise
  187. CURSOR_LEFT=Num Num4
  188. CURSOR_RIGHT=Num Num6        
  189. ;more than one definition is allowed!
  190. TO_LEFT_BORDER=Ctrl Left
  191. TO_RIGHT_BORDER=Ctrl Right
  192. SEND_INPUTS=Return        
  193. ;completes the input
  194. INSERT_^J=Shift Alt Return    
  195. ;inserts a Ctrl-J.
  196. TAB_FORWARDS=Tab
  197. TAB_BACKWARDS=Shift Tab        
  198. ;TAB cycling
  199. EXPAND_PATH=Ctrl Tab
  200. EXPAND_BACKWARDS=Ctrl Shift Tab    
  201. ;TAB expansion
  202. DELETE_FORWARDS=Del        
  203. ;the "Delete" function
  204. DELETE_BACKWARDS=Backspace    
  205. ;the "Backspace" function
  206. DELETE_FULL_LINE=Shift Del    
  207. ;delete all
  208. DELETE_WORD_FWDS=Shift Backspace
  209. DELETE_WORD_BKWDS=Alt Backspace    
  210. ;one word, backwards
  211. DELETE_COMPONENT_FWDS=Ctrl Alt Del
  212. DELETE_COMPONENT_BKWDS=Ctrl Alt Backspace
  213. DELETE_END_OF_LINE=Shift Alt Del
  214. DELETE_START_OF_LINE=Shift Alt Backspace
  215. ;the next are the standard clipboard functions
  216. CUT=RAmiga x            
  217. COPY=RAmiga c
  218. PASTE=RAmiga v
  219. TOGGLE_NUMLOCK=Alt Num[        
  220. ;Num[ is the '[' key on the numpad, this toggles the NumLock qualifier.
  221. YANK=RAmiga q            
  222. ;this is the intuition style "undo"
  223. HELP=Help            
  224. ;the HELP function, if used by the program
  225. INSERT_CSI=Alt Esc        
  226. ;inserts 0x9B
  227. INSERT_ESC=Shift Esc        
  228. ;inserts 0x1B
  229.  
  230. _____________________________________________________________________________
  231.  
  232.                          The THOR-Software Licence (v2, 24th June 1998)
  233.  
  234.  
  235. This License applies to the computer program known as "StringSnip".
  236. The "Program", below, refers to such program. The "Archive" refers to the 
  237. package of distribution, as prepared by the author of the Program, 
  238. Thomas Richter. Each licensee is addressed as "you".
  239.  
  240.  
  241.  
  242. The Program and the data in the archive are freely distributable
  243. under the restrictions stated below, but are also Copyright (c)
  244. Thomas Richter.
  245.  
  246. Distribution of the Program, the Archive and the data in the Archive by a
  247. commercial organization without written permission from the author to any
  248. third party is prohibited if any payment is made in connection with such
  249. distribution, whether directly (as in payment for a copy of the Program) or
  250. indirectly (as in payment for some service related to the Program, or
  251. payment for some product or service that includes a copy of the Program
  252. "without charge"; these are only examples, and not an exhaustive enumeration
  253. of prohibited activities).
  254.  
  255.  
  256. However, the following methods of distribution
  257. involving payment shall not in and of themselves be a violation of this
  258. restriction:
  259.  
  260.  
  261. (i) Posting the Program on a public access information storage and
  262. retrieval service for which a fee is received for retrieving information
  263. (such as an on-line service), provided that the fee is not
  264. content-dependent (i.e., the fee would be the same for retrieving the same
  265. volume of information consisting of random data).
  266.  
  267.  
  268. (ii) Distributing the Program on a CD-ROM, provided that
  269.  
  270. a) the Archive is reproduced entirely and verbatim on such CD-ROM, including
  271. especially this licence agreement;
  272.  
  273. b) the CD-ROM is made available to the public for a nominal fee only,
  274.  
  275. c) a copy of the CD is made available to the author for free except for
  276. shipment costs, and
  277.  
  278. d) provided further that all information on such CD-ROM is redistributable
  279. for non-commercial purposes without charge.
  280.  
  281.  
  282. Redistribution of a modified version of the Archive, the Program or the
  283. contents of the Archive is prohibited in any way, by any organization,
  284. regardless whether commercial or non-commercial. Everything must be kept
  285. together, in original and unmodified form.
  286.  
  287.  
  288.  
  289.  
  290. Limitations.
  291.  
  292.  
  293. THE PROGRAM IS PROVIDED TO YOU "AS IS", WITHOUT WARRANTY. THERE IS NO
  294. WARRANTY FOR THE PROGRAM, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT
  295. LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  296. PARTICULAR PURPOSE AND NONINFRINGEMENT OF THIRD PARTY RIGHTS. THE ENTIRE
  297. RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD
  298. THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY
  299. SERVICING, REPAIR OR CORRECTION.
  300.  
  301.  
  302. IF YOU DO NOT ACCEPT THIS LICENCE, YOU MUST DELETE THE PROGRAM, THE ARCHIVE
  303. AND ALL DATA OF THIS ARCHIVE FROM YOUR STORAGE SYSTEM. YOU ACCEPT THIS
  304. LICENCE BY USING OR REDISTRIBUTING THE PROGRAM.
  305.  
  306.  
  307.                                                         Thomas Richter
  308.  
  309. _____________________________________________________________________________
  310.  
  311. Thomas,
  312.     October 1999
  313.